package cn.fff.system.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

import java.util.ArrayList;
import java.util.List;

/**
 * knife4j 配置
 * 路径为 /doc.html
 */
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {

    @Value("${server.servlet.context-path:}")
    private String contextPath;

    /**
     * 如果有多个 Dockert，表示有多个分组
     * @return
     */
    @Bean
    public Docket adminApiConfig() {
        List<Parameter> pars = new ArrayList<>();
        ParameterBuilder tokenPar = new ParameterBuilder();
        tokenPar
                // 参数名称
                .name("token")
                // 参数说明
                .description("用户token")
                // 是否必填，如果为 true，前端在发送请求时会进行校验
                .required(false)
                // 默认填充值
                .defaultValue("")
                // 数据类型
                .modelRef(new ModelRef("string"))
                // 请求类型，header 表示参数通过请求 header 传递
                .parameterType("header")
                .build();
        pars.add(tokenPar.build());
        // 添加 head 参数 end
        Docket adminApi = new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                // 扫描 cn.fff 包下的 controller
                .apis(RequestHandlerSelectors.basePackage("cn.fff"))
                // 只显示 admin 路径下的页面
                .paths(PathSelectors.regex(contextPath + "/admin/.*"))
                .build()
                .globalOperationParameters(pars);
        return adminApi;
    }

    private ApiInfo adminApiInfo() {
        // 主页显示内容
        return new ApiInfoBuilder()
                // 主页 title
                .title("后台管理系统-API文档")
                // 简介
                .description("本文档描述了后台管理系统接口定义")
                // 作者
                .contact(new Contact("fff", "http://fff.com", "fff@163.com"))
                // 版本
                .version("1.0")
                .build();
    }
}
